Mappedin Android SDK/com.mappedin.sdk.web/MPIOptions/Init

Init

@Serializable

data class Init @JvmOverloads constructor( val clientId: String = "", val clientSecret: String = "", val venue: String = "", val perspective: String? = "Website", val baseUrl: String = "", val noAuth: Boolean = false, val firstMapId: String? = null, val headers: List<MPIHeader>? = null, val useBundle: Boolean? = false, val emitAnalyticsEvents: Boolean? = true, val useDraftData: Boolean? = false, val language: String? = null, val things: Map<MPIOptions.THING_KEY, List<String>> = emptyMap())

This class hold the properties of values to be used when initialzing a map

Constructors

Init

@JvmOverloads

constructor( clientId: String = "", clientSecret: String = "", venue: String = "", perspective: String? = "Website", baseUrl: String = "", noAuth: Boolean = false, firstMapId: String? = null, headers: List<MPIHeader>? = null, useBundle: Boolean? = false, emitAnalyticsEvents: Boolean? = true, useDraftData: Boolean? = false, language: String? = null, things: Map<MPIOptions.THING_KEY, List<String>> = emptyMap())

Properties

baseUrl

val baseUrl: String

Base url string of the venue

clientId

val clientId: String

Client id provided to you by Mappedin to access our API- Note: Contact your Mappedin representative if you do not have one.

clientSecret

val clientSecret: String

Client secret provided to you by Mappedin to access our API- Note: Contact your Mappedin representative if you do not have one.

emitAnalyticsEvents

val emitAnalyticsEvents: Boolean? = true

Whether analytics events should be sent.

firstMapId

val firstMapId: String? = null

Set the first map with first map id when showing the venue

headers

val headers: List<MPIHeader>? = null

An array of MPIHeader for requests

language

val language: String? = null

Language to load. Accepts an ISO 639-1 language code.

noAuth

val noAuth: Boolean = false

Boolean value of whether there is no authorization

perspective

val perspective: String?

Perspective of the venue

things

val things: Map<MPIOptions.THING_KEY, List<String>>

An object specifying additional properties to fetch for each data item. Each key represents a data item (e.g., 'locations', 'nodes'), and the value is an array of strings indicating extra properties to be included. Refer to MPIOptions.THING_KEY for a list of keys.

useBundle

val useBundle: Boolean? = false

Use a bundle for venue loading and cache it for faster subsequent loading

useDraftData

val useDraftData: Boolean? = false

Whether a draft map should be loaded. Default is false.

venue

val venue: String

Name string of your venue